Fix the Documentation build under ModelingToolkit v11 - #68
Merged
ChrisRackauckas merged 3 commits intoAug 28, 2026
Conversation
The Documentation build has been failing since MTK v11 became resolvable in the docs environment: the component DSL moved to SciCompDSL.jl, solvers are no longer re-exported by DifferentialEquations v8, `missing_variable_defaults` and `defaults` were removed, several standard-library components changed their constructor signatures, and symbolic defaults are now bindings rather than initial conditions. This updates the lecture examples to the current APIs so `makedocs` runs every `@example` block again, instead of capping MTK to v9. The hydraulic debugging model in lecture 6 is rewritten in the same functional `ODESystem` style used by the rest of that lecture, and its flattened variable names use `_` instead of the `₊` namespace separator, which MTK now strips defaults from. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
MathWorks returns HTTP 403 to Documenter's link checker for the referenced hydraulic chamber page. Exclude only that URL while retaining link checks for all other external references. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Codex <noreply@openai.com> Agent-Harness: Codex (version unknown) Agent-Model: gpt-5 Agent-Session: 01a04793-6175-7cf2-b514-9bcca858906d (local session ID)
ChrisRackauckas-Claude
force-pushed
the
fix-docs-mtk-v11
branch
from
August 28, 2026 10:18
e1b5a75 to
8dda68d
Compare
ChrisRackauckas-Claude
marked this pull request as draft
August 28, 2026 10:19
Member
Author
|
Added commit 8dda68d after rebasing onto current The final failure was Documenter receiving HTTP 403 from the MathWorks hydraulic-chamber reference. The new commit adds that exact URL to the existing Local discrimination:
AI attribution: Codex (version unknown), model gpt-5, local session ID |
Member
Author
|
Final CI verification for commit 8dda68d:
All four checks are green. The PR remains a draft and should be ignored until reviewed by @ChrisRackauckas. |
ChrisRackauckas
marked this pull request as ready for review
August 28, 2026 11:56
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed and why
The Documentation workflow became red when ModelingToolkit v11 was resolvable in
docs/Project.toml; the previous v9 cap in #64 was superseded by #65. This PR migrates the lecture examples to current APIs instead of restoring the cap.The migration covers the component DSL move to SciCompDSL, explicit solver-package imports, the replacement of removed defaults helpers with bindings and initial conditions, current ModelingToolkitStandardLibrary constructors, current solution statistics/indexing APIs, and the hydraulic examples. The final docs failure was unrelated to those examples: MathWorks consistently returns HTTP 403 to Documenter for the referenced hydraulic-chamber page, so only that URL is excluded from link checking while all other links remain checked.
Verification
Failing before the final fix:
Passing with the final fix applied:
Additional local checks on the rebased branch:
Not verified locally
A post-rebase repetition of the full docs command completed all examples but GitHub returned transient HTTP 429 responses for two GitHub-hosted links; both returned HTTP 200 immediately with
curl. Those valid links were not ignored or silenced. The successful full build above used the same final docs changes; CI remains the authoritative post-rebase link-check run. Localdeploydocsskipped deployment because the checkout was not a recognized CI environment. GPU and downstream jobs are not applicable to this docs-only change.The only link-check exception added here is the persistently bot-blocked MathWorks URL; broader GitHub link checking remains enabled.
🤖 Generated with Codex (version unknown) (model: gpt-5; session: 01a04793-6175-7cf2-b514-9bcca858906d, local session ID)